home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIWebBrowserStream.idl < prev    next >
Text File  |  2006-05-08  |  4KB  |  92 lines
  1. /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2001, 2002
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *  Marco Pesenti Gritti <marco@gnome.org>
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40.  
  41. interface nsIURI;
  42.  
  43. /**
  44.  * This interface provides a way to stream data to the web browser. This allows
  45.  * loading of data from sources which can not be accessed using URIs and
  46.  * nsIWebNavigation.
  47.  *
  48.  * @status FROZEN
  49.  */
  50. [scriptable, uuid(86d02f0e-219b-4cfc-9c88-bd98d2cce0b8)]
  51. interface nsIWebBrowserStream : nsISupports
  52. {
  53.   /**
  54.    * Prepare to load a stream of data. When this function returns successfully,
  55.    * it must be paired by a call to closeStream.
  56.    *
  57.    * @param aBaseURI
  58.    *        The base URI of the data. Must not be null. Relative
  59.    *        URIs will be resolved relative to this URI.
  60.    * @param aContentType
  61.    *        ASCII string giving the content type of the data. If rendering
  62.    *        content of this type is not supported, this method fails.
  63.    *        This string may include a charset declaration, for example:
  64.    *        text/html;charset=ISO-8859-1
  65.    *
  66.    * @throw NS_ERROR_NOT_AVAILABLE
  67.    *        The requested content type is not supported.
  68.    * @throw NS_ERROR_IN_PROGRESS
  69.    *        openStream was called twice without an intermediate closeStream.
  70.    */
  71.   void openStream(in nsIURI aBaseURI, in ACString aContentType);
  72.  
  73.   /**
  74.    * Append data to this stream.
  75.    * @param aData The data to append
  76.    * @param aLen  Length of the data to append.
  77.    *
  78.    * @note To append more than 4 GB of data, call this method multiple times.
  79.    */
  80.   void appendToStream([const, array, size_is(aLen)] in octet aData,
  81.                       in unsigned long aLen);
  82.  
  83.   /**
  84.    * Notifies the browser that all the data has been appended. This may notify
  85.    * the user that the browser is "done loading" in some form.
  86.    *
  87.    * @throw NS_ERROR_UNEXPECTED
  88.    *        This method was called without a preceding openStream.
  89.    */
  90.   void closeStream();
  91. };
  92.